Skip to content

Release notes display cleanup#1373

Merged
validbeck merged 8 commits into
mainfrom
beck/sc-16656/renew-release-notes-process
Jul 4, 2026
Merged

Release notes display cleanup#1373
validbeck merged 8 commits into
mainfrom
beck/sc-16656/renew-release-notes-process

Conversation

@validbeck

@validbeck validbeck commented Jul 3, 2026

Copy link
Copy Markdown
Collaborator

Pull Request Description

What and why?

Simplifies the public releases hub so current releases, feature highlights, and the historical archive are easier to scan.

Documentation / index

  • Adds #releases anchor on the home page Latest Features section for deep links
  • Replaces flex filler columns with a responsive two-column grid (.academy-features-row) so Academy and Latest Features align evenly on desktop and stack on mobile instead of having weird extra padding

All releases

  • Current releases grid now shows four tiles: Platform, Library, Documentation updates, and Breaking changes and deprecations (breaking changes moved up from sidebar-only)
  • Latest feature highlights table capped at six items (was 10) with green View all button
  • Removes the embedded 2025 monthly table from this page — archive lives under updated sidebar Release archive only
  • Adds Release archive prose explaining the April 2025 format split (25.03 and earlier vs 25.04+)

How to test

Click on the live previews:

Confirm the four-tile current-releases grid, six-row highlights table, and archive copy render without listing errors.

What needs special review?

Dependencies, breaking changes, and deployment notes

Warning

Remove the ref: to the paired release-notes branch under the release notes step in validate-docs-site.yaml before merging.

Related epic PRs

  1. release-notes
  2. skills
  3. installation
  4. validmind-library

Release notes

n/a

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)

Point validate-docs-site at beck/sc-16656/renew-release-notes-process
so staging previews include in-progress release notes CSS and listings.
Remove ref before merge.
@validbeck validbeck added the internal Not to be externalized in the release notes label Jul 3, 2026
@validbeck

Copy link
Copy Markdown
Collaborator Author

Merge guard — remove ref: before merge

This PR temporarily adds ref: beck/sc-16656/renew-release-notes-process to the Check out release-notes repository step in .github/workflows/validate-docs-site.yaml.

Do not merge until:

  1. The linked release-notes PR merges (or you no longer need the branch pin)
  2. You remove the ref: line from that workflow step on this branch
  3. Validate docs site passes again on this PR

After merge, main should check out release-notes default branch (no ref:).

Closes missing ::: so Quarto validate-docs-site CI no longer warns.

Co-authored-by: Cursor <cursoragent@cursor.com>
Comment thread .github/workflows/validate-docs-site.yaml Outdated
@validbeck validbeck requested a review from cachafla July 3, 2026 07:47
@github-actions

github-actions Bot commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

PR Summary

This PR introduces several UI enhancements and content updates across the site. The changes can be summarized in two parts:

  1. Academy Features Section (site/index.qmd):

    • New CSS classes (.academy-features-row and .academy-features-col) are added to structure and control the layout of the academy features section.
    • The grid layout is updated to use two columns on larger screens, while on mobile (max-width: 768px) the layout adapts to a single column with adjusted spacing.
    • Markup changes replace existing utility classes with these new academy-specific classes, which improves clarity and consistency in the layout design.
  2. Release Navigation Updates (site/releases files):

    • In the sidebar configuration (site/releases/_sidebar.yaml), the text label for older releases is changed from "Older releases" to "Release archive" to provide clearer navigation.
    • In the release listing file (site/releases/all-releases.qmd), the presentation of releases is modified:
      • A new grid configuration is introduced for the release pages by specifying grid-columns, to facilitate a more balanced display of release entries.
      • The legacy table view for listing releases is removed, streamlining the page layout.
      • Adjustments in the feature highlights section include changing page limits and button styling to improve usability.
    • The instructional text regarding the release notes format has been updated to differentiate between release archives and current releases, making it easier for users to locate the relevant information.

Overall, these changes improve responsiveness and the visual layout of the academy features section while also refining the navigation and structure of the release notes section.

Test Suggestions

  • Verify that the academy features section displays in a two-column grid layout on desktop and switches to a single-column layout on mobile screens.
  • Check that the new CSS classes (.academy-features-row and .academy-features-col) are properly applied and overriding the old layout classes.
  • Confirm that the sidebar now displays 'Release archive' instead of 'Older releases'.
  • Ensure that the release listing in all-releases.qmd correctly displays in a grid format with the expected number of columns and items.
  • Test the feature highlights section to confirm that the button styling and layout adjustments render as intended on various devices.

@github-actions

github-actions Bot commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@validbeck validbeck merged commit 044bf94 into main Jul 4, 2026
7 checks passed
@validbeck validbeck deleted the beck/sc-16656/renew-release-notes-process branch July 4, 2026 00:35
@github-actions

github-actions Bot commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Lighthouse check results

✓ INFO: Average accessibility score is 0.92 (required: ≥0.9) — View the workflow run

Audit mode: changed pages (2 URL(s))

Show Lighthouse scores

Commit SHA: f4b365d

For a thorough audit, run the Lighthouse check workflow manually (Actions → Lighthouse check → Run workflow) with depth 0–2, or add the lighthouse:full label for depth 2 on the next validate run.

Page Accessibility Performance Best Practices SEO
/index.html 0.93 0.63 1.00 0.82
/index.html 0.93 0.66 1.00 0.82
/releases/all-releases.html 0.91 0.71 0.96 0.82
/releases/all-releases.html 0.91 0.72 0.96 0.82
/index.html 0.93 0.62 1.00 0.82
/releases/all-releases.html 0.91 0.71 0.96 0.82

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants